Separate build instructions for Windows and Unix into separate sections in README.md #664
Conversation
|
Will work out how best to fix the linter issues next week (almost all about now having duplicate headers). Feel free to provide feedback on the idea of the PR in the meantime though. I will stop the workflows for now, and they can run when I fix the linter issues. |
mcbarton
force-pushed
the
Neaten-readme-build-instrucgtions
branch
2 times, most recently
from
a0eddb2 to
f21a206
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #664 +/- ##
=======================================
Coverage 79.52% 79.52%
=======================================
Files 9 9
Lines 3917 3917
=======================================
Hits 3115 3115
Misses 802 802 🚀 New features to boost your workflow:
|
|
Now that the markdown linter is passing for this PR it is ready for review. |
Thanks for the feedback. I was thinking about this idea already, and will implement it sometime this week. |
mcbarton
force-pushed
the
Neaten-readme-build-instrucgtions
branch
4 times, most recently
from
cadd5d5 to
8fec127
Compare
mcbarton
force-pushed
the
Neaten-readme-build-instrucgtions
branch
from
f2c5826 to
c4b4da9
Compare
|
@Vipul-Cariappa I have applied your suggestion if you want to take another look. @vgvassilev pinging for a review. This PR changes how the build instructions are navigated in the readme file (by using expandable sections). Go here https://github.com/mcbarton/CppInterOp/tree/Neaten-readme-build-instrucgtions to see what it would look like. |
There was a problem hiding this comment.
This looks good to me.
I did not read the entire thing; Maybe we should specify somewhere that Clang-REPL is the preferred way to build CppInterOp, instead of Cling. @vgvassilev any thoughts?
2 participants
Description
Please include a summary of changes, motivation and context for this PR.
There is a lot of back and forth in the build instructions in the readme for different platforms. To quickly get a set of instructions for either Windows or a Unix platform this PR arranges them into clickable sections when viewed on Github. e.g. it looks like this, where you click on the platform you want, to get the instructions just for that platform
To me this a lot cleaner, and easier for a beginner to decipher what exact instructions the user wants for their platform. To see how this looks in practice, and how it neatens everything up, see the branch of this PR https://github.com/mcbarton/CppInterOp/tree/Neaten-readme-build-instrucgtions
Fixes # (issue)
Type of change
Please tick all options which are relevant.
Testing
Please describe the test(s) that you added and ran to verify your changes.
Checklist